home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / wadgc2 / wadgc.nfo < prev    next >
Encoding:
Text File  |  1994-07-31  |  6.1 KB  |  164 lines
  1. WADGC - a simple PWAD graphics compiler (pre-release version, July 27, 1994)
  2.  
  3. The program takes a text input file, and creates a PWAD file for Doom
  4. version 1.1, 1.2 or 1.5 with any or all of the following entries:
  5.  
  6. Sprites (curently between S_START and S_END entries as required for Doom 1.2)
  7.  
  8. Floor and ceiling textures (between F_START and F_END entries)
  9.  
  10. Wall patches, PNAMES, TEXTURE1 & TEXTURE2 entries
  11.  
  12. Note that TEXTURE1/2 and PNAME resources can only fully replace those
  13. already in the IWAD. Therefore, the original resource data are kept
  14. and any new patch names and textures appended to them. Since the original
  15. data is copyrighted, you'll have to extract it from your DOOM.WAD for
  16. yourself. Use the supplied utility WADEXT, or DEU or any other suitable
  17. WAD editor, and extract the entries PNAMES, TEXTURE1 and TEXTURE2 as raw
  18. data into files named "pnames.raw", "texture1.raw" and "texture2.raw",
  19. respectively, and you're ready to go.
  20.  
  21. As of Doom version 1.2, sprites can only be replaced on a wholesale basis.
  22. Every sprite for every object must be explicitly present between
  23. S_START...S_END entries in your PWAD. This will change in version 1.5.
  24.  
  25. Floor textures can NOT be included in PWAD files. You need to build a
  26. new IWAD file to change these freely, and if you do, a few names must
  27. still be present for Doom to run, since they are used for a few other
  28. purposes, too. Refer to the Unofficial Doom specs for details. See also
  29. the utility NEWFLATS in the vicinity of this document.
  30.  
  31. The input file is a plain ASCII text file. The spelling is crucial,
  32. and everything is case-sensitive. Extra blank lines, spaces and tabs are
  33. allowed anywhere, though, to increase the readability. Comments are
  34. allowed and should be preceded with a hash (#). Comments can be placed
  35. on a line of their own or after a command on the same line. Everything
  36. from the # to the next end of line is considered a comment and ignored.
  37.  
  38. Input PPM files must be in raw format (P6), not text format (P3). The
  39. image is color quantized to the Doom palette when it is read in. If you
  40. want to be certain about the results, use only the Doom colors when you
  41. create the image in the first place. My quantization is a raw extensive
  42. search for a best fit on a pixel by pixel basis, which is quite crude and
  43. very slow. If only the Doom palette colors are used, images will be read
  44. in about 30 times faster.
  45.  
  46. Existing textures may be replaced, and new ones added. Changing existing
  47. textures is needed to change the frame animated walls. All replacement
  48. textures must be listed before any new textures, and they must be in the
  49. same order as in the original IWAD file. This is similar to the utility
  50. NEWFLATS. It is a limitation, but not a severe one. What it restricts you
  51. from doing is changing the number of animation frames for animated walls.
  52.  
  53.  
  54. The input text file format should be as follows.
  55.  
  56. The sprites section:
  57. --------------------
  58. S_START
  59. <spritename> <ppmfilename> @ <x_origin y_origin> W <width> H <height> X <x_insertion> Y <y_insertion>
  60. ...
  61. S_END
  62.  
  63. x_origin and y_origin define the upper left corner for the sprite image
  64. within the ppm image. Having several sprites in one input image gives
  65. you a better overview when editing them.
  66.  
  67.  
  68. The wall patches section:
  69. -------------------------
  70. P_START
  71. <patchname> <filename> @ <xorigin yorigin> W <width> H <height>
  72. ...
  73. P_END
  74.  
  75. Apart from the lack of an insertion point, this is exactly the same
  76. format as the sprites section. The insertion point for wall patches
  77. is always at the middle of the bottom row of pixels.
  78. The P_START/P_END markers are actually not written to the WAD file.
  79. If they were, all the original wall patches would become inaccessible.
  80. New wall patches are just placed on the top level in the WAD directory.
  81. Therefore, make sure they do not have the same name as any of the
  82. existing entries: wall patches, sprites or non-graphic resources.
  83. (Unless you want to replace an existing wall patch, in which case you
  84.  should of course specify the same name as the existing one.)
  85.  
  86.  
  87. The textures section:
  88. ---------------------
  89. TEXTURE1_START
  90. <texturename> <width> <height> <numpatches>
  91. <patchname> <xoffset> <yoffset>
  92. <patchname> <xoffset> <yoffset>
  93. ...
  94. <texturename> <numpatches>
  95. <patchname> <xoffset> <yoffset>
  96. ...
  97. TEXTURE1_END
  98. TEXTURE2_START
  99. (exactly like TEXTURE1 above)
  100. TEXTURE2_END
  101.  
  102. Note that patches are referred to by name. All the names used must
  103. be present either in the original PNAMES entry or in the P_START..P_END
  104. section.
  105.  
  106. The floor/ceiling section:
  107. --------------------------
  108. F_START
  109. F1_START
  110. <texturename> <filename> @ <xorigin yorigin>
  111. F1_END
  112. F2_START
  113. <texturename> <filename> @ <xorigin yorigin>
  114. F2_END
  115. F_END
  116.  
  117. Apart from the absence of a size specification, this is
  118. the same format as the wall patch section. The width and
  119. height of these textures are always 64.
  120. Either F1_START..F1_END or F2_START..F2_END may be omitted.
  121.  
  122. Note that having floor/ceiling entries in a PWAD file gives an
  123. error if you try to run Doom with it using the -file option.
  124. For information on how to make your own flats, see the file
  125. NEWFLATS.README.
  126.  
  127. Any of the sections S_START...S_END, P_START...P_END,
  128. TEXTURE1_START...TEXTURE1_END, TEXTURE2_START...TEXTURE2_END or
  129. F_START...F_END may be omitted. The presence of the section
  130. P_START...P_END automatically generates a PNAMES entry. The
  131. presence of any of the sections TEXTUREn_START...TEXTUREn_END
  132. yields a corresponding TEXTUREn entry.
  133.  
  134.  
  135. Example input file:
  136. -------------------
  137. # A very simple example input file for WADGC
  138. S_START # Some dummy sprites
  139.  TESTSPR1 test.ppm @ 0 0 W 8 H 8 X 4 Y 8 # The first test sprite
  140.  TESTSPR2 test.ppm @ 8 0 W 8 H 8 X 4 Y 8 # A second test sprite
  141. S_END
  142.  
  143. P_START # A few new wall patches
  144.  TESTPTC1 test.ppm @ 0 8 W 8 H 8
  145.  TESTPTC2 test.ppm @ 8 8 W 8 H 8
  146. P_END
  147.  
  148. TEXTURE1_START # One replacement texture for AASTINKY and one all new
  149.  AASTINKY 8 16 2
  150.   TESTPTC1 0 0
  151.   TESTPTC2 0 8
  152.  TESTWALL 16 16 4
  153.   TESTPTC1 0 0
  154.   TESTPTC2 0 8
  155.   TESTPTC1 8 0
  156.   TESTPTC2 8 8
  157. TEXTURE1_END
  158.  
  159. F_START # Floor tiles are actually not allowed in PWADS
  160.  F1_START
  161.   TESTFLR1 test.ppm @ 0 0
  162.  F1_END
  163. F_END
  164.